协议版本

平台支持标准 MQTT 3.1.1版本

协议支持

报文支持

• 平台支持connect、subscribe、publish、ping、unsubscribe、disconnect等报文
• 平台不支持pubrec、pubrel、pubcomp报文

特性支持

平台对协议特性支持如下：

Topic约定

• 下列topic中pid后面是改设备的产品id，devkey后面是该设备的设备id

普通设备

基础通信Topic

物模型通信Topic

自定义Topic

用户可以根据实际情况，自行定义Topic。

透传设备

基础通信Topic

物模型通信Topic

自定义Topic

用户可以根据实际情况，自行定义Topic。

数据上传payload格式

设备属性主动上报

发布Topic：$sys/{pid}/{did}/thing/property/post，格式如下：

{
  "id": "123",
  "version": "1.0",
  "params": {
    "Power": {
      "value": "on",
      "time": 1524448722123
    },
    "WF": {
      "value": 23.6,
      "time": 1524448722123
    }
  }
}

表：请求参数说明

响应：$sys/{pid}/{did}/thing/property/post/reply，格式如下：

{
  "id": "123",
  "code":xxxx,
  “msg”:"xxxx"
}

表:响应参数说明表

设备属性设置

订阅Topic：$sys/{pid}/{did}/thing/property/set，JSON数据格式如下：

{
  "id": "123",
  "version": "1.0",
  "params": {
    "temperature": "30.5"
    ...
  }
}

表：请求参数说明

回复Topic：$sys/{pid}/{did}/thing/property/set_reply，格式如下：

{
  "id": "123"
  "code":xxxx,
  "msg":"xxxx"
}

表:响应参数说明表

设备事件主动上报

发布Topic：$sys/{pid}/{did}/thing/event/post，格式如下：

{
    "id": "123", 
    "version": "1.0", 
    "params": {
        "identifier1": {
            "value": {
                "Power": "on", 
                "WF": "2"
            }, 
            "time": 1524448722123
        }, 
        "identifier2": {
            "value": {
                "Power": "on", 
                "WF": "2"
            }, 
            "time": 1524448722123
        }
    }
}

表: 参数说明

服务调用

订阅Topic：$sys/{pid}/{did}/thing/service，JSON数据格式如下：

{
  "id": "123",
  "version": "1.0",
  "productId:100288,
  "deviceId": 10007337,
  "callType": 1,
  "serviceName":"service_1",
  "params": {
      "int":100,
      "string":"abcde"
  },
 "timeout":20
}

表：请求参数说明

回复Topic：$sys/{pid}/{did}/thing/service/reply，格式如下：

{
  "id": "123"
  "code":xxxx,
  "msg":"xxxx",
  "params":{
    "output":123,
    "output2":"123"
  }
}

表:响应参数说明表

时钟同步

1. 设备端订阅Topic：$sys/{pid}/{did}/ext/ntp/response

2. 设备请求topic：$sys/{pid}/{did}/ext/ntp/request 设备向平台发送一条QoS=0的消息，payload中带上设备当前的时间戳，单位为毫秒。示例如下：

   {
    "deviceSendTime":"1571724098000"
   }
   

3. 设备端收到服务端回复的消息，payload中包含以下信息：

{
    "deviceSendTime":"1571724098000",
    "serverRecvTime":"1571724098110",
    "serverSendTime":"1571724098115",
}

1. 设备端计算出当前精确的unix时间。 设备端收到服务端的时间记为${deviceRecvTime}，则设备上的精确时间为：(${serverRecvTime} + ${serverSendTime} + ${deviceRecvTime} - ${deviceSendTime}) / 2

设备日志

• 数据上行

请求Topic： $sys/{did}/{pid}/thing/log/post 响应Topic: $sys/{did}/{pid}/thing/log/post_reply 请求数据:

{
    "version":"1.0",
    "params" :[{
          "utcTime":  "2020-03-06T15:15:27.464+0800",  
          "logLevel": "ERROR",          
          "module": "ModuleA",         
          "code" :"4103",                       
          "traceContext": "123456",    
          "logContent" : "some log content" 
         }], 
    "method" : "thing.log.post"
}

表 . 参数说明

响应数据:

{
"code":200,
"msg":"msg"
}

表 . 响应参数说明

广播消息下发

• 设备订阅广播topic:$sys/{pid}/broadcast/request

请求内容为一个json对象

```

## 设备reset
* 设备上报reset消息：`$sys/{did}/{pid}/ext/reset/request`
请求数据:
```json
{
    "id":"123"
}

表 . 参数说明

响应数据:

{
    "id":"123",
    "code":200,
    "msg":"msg"
}

表 . 响应参数说明

设备ota

• （可选）设备连接OTA服务，上报版本号。 设备端通过MQTT协议推送当前设备OTA模块版本号到Topic：$sys/{pid}/{did}/ota/device/inform 消息格式如下： 请求数据:

  {
  "params": {
    "pid":"100040",
    "did":"10000064",
    "fVersion":"2.0", 
    "sVersion":"2.0", 
    "manuf":"001",
    "model":"00108"
  }
  }
  

  表 . 参数说明

• 您在控制台触发升级操作之后，设备会收到物联网平台OTA服务推送的升级包的URL地址。 设备端订阅Topic：$sys/{pid}/{did}/ota/device/upgrade 控制台对设备发起OTA升级请求后，设备端会通过该Topic收到升级包的存储地址URL。

消息格式如下：

{
  "code": 200,
  "data":{
      "target":"1.2", 

      "token":"ota_5hc95SFeo5xJEnaNrste",

      "size":123,

      "signal":12,

      "power":90,

      "retry":10,

      "interval":90,

      "md5":"dfkdajkfd",

      "url":"172.19.3.3:8002/ota/download/ota_5hc95SFeo5xJEnaNrste"
  }   
}

表 . 参数说明

• 设备收到URL之后，通过HTTP协议根据URL下载升级包。
• 升级过程中，设备端向服务端推送升级进度到Topic：$sys/{pid}/{did}/ota/device/progress; 消息格式如下：

  {
  "params": {
    "pid":"123",
    "did":"123",
    "step":11, 
    "token":"ota_5hc95SFeo5xJEnaNrste"
  }
  }
  

  表 . 参数说明

• 设备端完成OTA升级后，推送升级状态到Topic：$sys/{pid}/{did}/ota/device/status。

  {
  "params": {
    "pid":"123",
    "did":"123",
    "result":101,
    "token":"ota_5hc95SFeo5xJEnaNrste"
  }
  

  表 . 参数说明

设备影子

见设备影子。

配置更新

设备订阅：$sys/{pid}/{did}/thing/config/push 设备获取平台下发的配置，配置格式是json，具体内容用户自定义